/*
 * Copyright 2012-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.actuate.endpoint.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.boot.actuate.endpoint.EndpointId;

/**
 * 标识一个类型为执行器（actuator）端点，用于提供运行中应用程序的信息。 端点可以通过多种技术进行暴露，包括 JMX 和 HTTP。
 * <p>
 * 大多数 {@code @Endpoint} 类会声明一个或多个使用
 * {@link ReadOperation @ReadOperation}、{@link WriteOperation @WriteOperation}、
 * {@link DeleteOperation @DeleteOperation} 注解的方法，这些方法将会被自动适配 为具体的暴露技术（如 JMX、Spring
 * MVC、Spring WebFlux、Jersey 等）。
 * <p>
 * {@code @Endpoint} 表示端点的最低通用标准，它有意限制了可定义的操作方法类型， 以支持尽可能广泛的暴露技术范围。如果你需要对某种特定技术的更深入支持，
 * 可以编写一个 {@link FilteredEndpoint 仅适用于某种技术} 的端点， 或者为通用端点提供 {@link EndpointExtension 扩展}。
 *
 * @author Andy Wilkinson
 * @author Phillip Webb
 * @see EndpointExtension
 * @see FilteredEndpoint
 * @see EndpointDiscoverer
 * @since 2.0.0
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Endpoint {

	/**
	 * 端点的标识符（必须遵循 {@link EndpointId} 的规则）。
	 * @return 端点 ID
	 * @see EndpointId
	 */
	String id() default "";

	/**
	 * 指定该端点是否默认启用。
	 * @return 如果该端点默认启用则返回 {@code true}
	 */
	boolean enableByDefault() default true;

}
